Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Adds definitions for node terminology and links #1031

Merged
merged 12 commits into from
Feb 25, 2022
Merged

Adds definitions for node terminology and links #1031

merged 12 commits into from
Feb 25, 2022

Conversation

Annamarie2019
Copy link
Contributor

In addition to addressing #245: Disambiguating nodes, peers, instances, vs. daemons, I also made it a little more user friendly....so it also makes a little bit of a dent in #951: Simplify the Concept/Nodes page. I add definitions of various node terms, move types next (I think those are easier to understand than the Go and JS implementations), and I add a sentence about what implementations have to do with nodes. There may be more that someone can do for #951.

I will not be surprised if the reviewer makes several requests. I'm aware of these things:

  • Do you think I have too many links for each term?
  • Is "instances" used only for applications Go-IPFS and JS-IPFS?
  • I added a sentence to the introduction of Implementations. Did I get that right? At first glance, it's not clear why we're talking about implementations when this page is about nodes.

@Annamarie2019 Annamarie2019 mentioned this pull request Feb 15, 2022
Closed
@ipfs ipfs deleted a comment from filecorgi Feb 16, 2022
@Annamarie2019 Annamarie2019 mentioned this pull request Feb 18, 2022
Closed
yusefnapora
yusefnapora approved these changes Feb 23, 2022
View reviewed changes
Copy link
Contributor

@yusefnapora yusefnapora left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a huge improvement - nice work @Annamarie2019.

I caught a couple small typos and such, but nothing major.

I'm a "more links the merrier" kind of guy, so that seems all good :)

As far as "instances" go, that's kind of a tricky one... in my head, an "instance" is the actual running code / process, executing on a specific machine at a point in time. So, if I upgrade from say go-ipfs 0.4 to 0.5, I've replaced my old instance with a new one. But, since I haven't changed my "identity" key, it's still the same "node" as far as the IPFS network is concerned.

I'm not sure if everyone shares that definition... @johnnymatthews what do you think? At any rate, I think the definition you used is better than the nothing that we have now 😄

docs/concepts/hashing.md Outdated Show resolved Hide resolved
docs/concepts/hashing.md Show resolved Hide resolved
docs/concepts/nodes.md Show resolved Hide resolved
docs/concepts/nodes.md Outdated Show resolved Hide resolved
@filecorgi
Copy link
Contributor

  • Image optimization came back clean!
  • Vuepress build was successful!

docs/community/chat.md:

docs/concepts/faq.md:

  • The phrase ‘a lot of’ might be wordy. Consider using “many”, “numerous” or “countless”. 
    ...I start contributing to IPFS? There are a lot of ways you can contribute to ...
                                           ^^^^^^^^
  • Consider using “many”. 
    ...sand contributors around the world from many different projects. There are a...
                                           ^^^^^^^^^^^^^^
  • Possible typo detected. 
    ...ment on many related protocols, such as libp2p and Filecoin, with the aim of...
                                           ^^^^^^

docs/concepts/glossary.md:

  • The following link returned HTTP status code 301 (Moved Permanently):
    https://github.com/libp2p/specs/blob/master/autonat/
  • The following link returned HTTP status code 301 (Moved Permanently):
    https://github.com/ipfs/research-CRDT
  • Possible typo detected. 
    ...unction of the IPFS networking layer in libp2p, wherein a peer can tell othe...
                                           ^^^^^^
  • Possible missing comma found. 
    ...rs that it has data blocks available. # AutoNAT The libp2p protocol that all...
                                           ^^^^^^^
  • Possible typo detected. 
    ...as data blocks available. # AutoNAT The libp2p protocol that allows a peer t...
                                           ^^^^^^
  • As an alternative to the over-used intensifier ‘very’, consider replacing this phrase. 
    ..."Qm". Uses a base 58-encoded multihash, very simple but much less flexible t...
                                           ^^^^^^^^^^^
  • Possible missing comma found. 
    ...ons of CID. More about CID v1 # Circuit relay A libp2p term for transport pr...
                                           ^^^^^
  • Possible typo detected. 
    ...ID. More about CID v1 # Circuit relay A libp2p term for transport protocol t...
                                           ^^^^^^
  • Possible missing comma found. 
    ...on  (opens new window). # Circuit relay v2 Truly decentralized relay impleme...
                                           ^^
  • Possible missing comma found. 
    ...ee specification  (opens new window). # Codec A function that encodes or dec...
                                           ^^^^^
  • Possible missing comma found. 
    ...mented as part of Multicodec. # Content addressing A way to store informatio...
                                           ^^^^^^^^^^
  • Use a comma before ‘so’ if it connects two independent clauses (unless they are closely connected and short). 
    ...nt addressing A way to store information so a device can retrieve the data b...
                                           ^^^
  • Although a hyphen is possible, it is not necessary in a compound modifier in which the first word is an adverb that ends in ‘ly’. 
    ...eplicated Data Type (CRDT) is a type of specially-designed data structure us...
                                           ^^^^^^^^^^^^^^^^^^
  • Consider using “many”. 
    ... systems, blockchains, and for modeling many different kinds of information....
                                           ^^^^^^^^^^^^^^
  • Before the countable noun ‘of’ an article or a possessive pronoun is necessary. 
    ...claiming certain specific structures of map and assigning them this meaning....
                                           ^^^
  • As an alternative to the over-used intensifier ‘very’, consider replacing this phrase. 
    ...AG-PB DAG-PB is a codec that implements a very small subset of the IPLD Data...
                                           ^^^^^^^^^^^^
  • It appears that a comma is missing. 
    ... DAG-PB  (opens new window) # Data model Did you mean IPLD Data Model  (open...
                                           ^^^^
  • Possible missing comma found. 
    ...ubset of the IPFS DHT. More about DHT # DMT Short for Data Model Tree, a ter...
                                           ^^^
  • Possible typo detected. 
    ...unction of the IPFS networking layer in libp2p, wherein a connection is open...
                                           ^^^^^^
  • Uncountable nouns are usually not used with an indefinite article. Use simply “transport”. 
    ...entation of dialing and listening forms a transport. # DNSLink DNSLink is a ...
                                           ^^^^^^^^^^^
  • ‘by accident’ might be wordy. Consider a shorter alternative. 
    ...le webpage, website, or service, either by accident or on purpose. # E # F #...
                                           ^^^^^^^^^^^
  • Possible missing comma found. 
    ...er by accident or on purpose. # E # F # Filestore An experimental data store...
                                           ^^^^^^^^^
  • This phrase is duplicated. You should probably use “Garbage Collection” only once. 
    ...ore about Gateway  (opens new window) # Garbage Collection Garbage Collectio...
                                           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  • ‘under discussion’ might be wordy. Consider a shorter alternative. 
    ...lternative content replication protocol under discussion, similar to Bitswap...
                                           ^^^^^^^^^^^^^^^^
  • Possible missing comma found. 
    ...raphsync  (opens new window) # H # HAMT-sharding The sharding technique used...
                                           ^^^^^^^^
  • ‘exact same’ might be wordy. Consider a shorter alternative. 
    ...) and returns a fixed-length value. The exact same input data will always ge...
                                           ^^^^^^^^^^
  • Only proper nouns start with an uppercase character (there are exceptions for headlines). 
    ...re numerous hash algorithms. More about Hash # Hole punching A  technique fo...
                                           ^^^^
  • Possible missing comma found. 
    ...hash algorithms. More about Hash # Hole punching A  technique for NAT or fir...
                                           ^^^^^^^^
  • This phrase is duplicated. You should probably use “Information Space” only once. 
    ...arding is not possible. See DCUtR # I # Information Space Information Space ...
                                           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  • ‘in support of’ might be wordy. Consider a shorter alternative. 
    ...(IPLD) model is a set of specifications in support of decentralized data str...
                                           ^^^^^^^^^^^^^
  • Only proper nouns start with an uppercase character (there are exceptions for headlines). 
    ...ged. More about IPNS # J # JS-IPFS node Runs in the browser with a limited s...
                                           ^^^^
  • This expression is ususally spelled with a hyphen 
    ...SON is a text format that is completely language independent, human-readable...
                                           ^^^^^^^^^^^^^^^^^^^^
  • Possible missing article found. 
    ... JSON  (opens new window) # K # L # LAN Local Area Network (LAN) is a type o...
                                           ^^^^^
  • Possible typo detected. 
    ...ther node. This is opposed to a root. # libp2p The libp2p project is a modul...
                                           ^^^^^^
  • Possible typo detected. 
    ...This is opposed to a root. # libp2p The libp2p project is a modular system o...
                                           ^^^^^^
  • Possible typo detected. 
    ...essential component of IPFS. More about libp2p  (opens new window) # Listeni...
                                           ^^^^^^
  • Possible typo detected. 
    ...unction of the IPFS networking layer in libp2p, wherein an incoming connecti...
                                           ^^^^^^
  • Uncountable nouns are usually not used with an indefinite article. Use simply “transport”. 
    ...entation of dialing and listening forms a transport. # Link In IPFS and IPLD...
                                           ^^^^^^^^^^^
  • This word has been used in one of the immediately preceding sentences. Using a synonym could make your text more interesting to read, unless the repetition is intentional. 
    ...nsport. # Link In IPFS and IPLD, a link usually means a pointer to some CID....
                                           ^^^^^^^
  • The preposition ‘as’ seems more likely in this position. 
    ... a computer science data structure used at the core of IPFS files/block stor...
                                           ^^
  • The preposition ‘of’ seems more likely in this position. 
    ...lock storage. Merkle-DAGs create a hash to their content, known as a Content...
                                           ^^
  • This phrase is duplicated. You should probably use “Merkle Forest” only once. 
    ...ent Identifier. More about Merkle-DAG # Merkle Forest Merkle Forest is a phr...
                                           ^^^^^^^^^^^^^^^^^^^^^^^^^^^
  • Possible typo detected. 
    ... and future-proof network addresses. In libp2p, it is used in peer addressin...
                                           ^^^^^^
  • Possible missing comma found. 
    ...aring in text. In IPFS, it is used as a prefix specifying the encoding used ...
                                           ^^^^^^
  • Possible missing article found. 
    ...AT service to allow multiple devices in local network (LAN) to access the in...
                                           ^^^^^
  • Possible missing comma found. 
    ...n to another is an edge. # O # P # Path/Address A Path/Address is the method...
                                           ^^^^^^^
  • Possible missing comma found. 
    ...alization. See also Peer as Node # Peer ID A Peer ID is how each unique IPFS...
                                           ^^
  • Possible missing comma found. 
    ...what remote pins are. # Pinning Service API A vendor-agnostic API specificat...
                                           ^^^
  • Possible missing comma found. 
    ...sub  (opens new window) # Q # R # Relay node A means to establish connectivi...
                                           ^^^^
  • Possible typo detected. 
    ...means to establish connectivity between libp2p nodes (e.g., IPFS nodes) that...
                                           ^^^^^^
  • Insert a space between the numerical value and the unit symbol. 
    ...hunks of a file together. If you have a 600MiB file A, it can be split into ...
                                           ^^^^^^
  • Insert a space between the numerical value and the unit symbol. 
    ..., and D since the block size of IPFS is 256MiB. The node A that links to eac...
                                           ^^^^^^
  • Possible missing comma found. 
    ...Digital signature  (opens new window) # Substrate A vocabulary term in IPLD,...
                                           ^^^^^^^^^
  • Only proper nouns start with an uppercase character (there are exceptions for headlines). 
    ...tions from other IPFS peers. More about Swarm addresses # T # Transport In l...
                                           ^^^^^
  • Possible typo detected. 
    ...bout Swarm addresses # T # Transport In libp2p, transport refers to the tech...
                                           ^^^^^^
  • Possible missing comma found. 
    ... garbage-collected. More about UnixFS # Urlstore An experimental data store ...
                                           ^^^^^^^^
  • It seems likely that a singular genitive (’s) apostrophe is missing. 
    ... similar to filestore, but it retrieves blocks contents via a HTTP URL inste...
                                           ^^^^^^
  • Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’. 
    ...e, but it retrieves blocks contents via a HTTP URL instead of a local filesy...
                                           ^

docs/concepts/hashing.md:

  • ‘exact same’ might be wordy. Consider a shorter alternative. 
    ...e represented by SHA-1 as: However, the exact same input generates the follo...
                                           ^^^^^^^^^^
  • ‘exactly the same’ might be wordy. Consider a shorter alternative. 
    ...- the same input message always returns exactly the same output hash uncorre...
                                           ^^^^^^^^^^^^^^^^
  • Consider using a different adverb to strengthen your wording. 
    ...l change in the message should generate a completely different hash unique -...
                                           ^^^^^^^^^^^^

docs/concepts/how-ipfs-works.md:

  • Only proper nouns start with an uppercase character (there are exceptions for headlines). 
    ...e identification via content addressing Content linking via directed acyclic...
                                           ^^^^^^^
  • The phrase ‘look for a book’ is used very frequently. Consider using a less frequent alternative to set your writing apart from others. 
    ... do all the time. For example, when you look for a book in the library, you ...
                                           ^^^^^^^^^^^^^^^
  • For conciseness, consider replacing this expression with an adverb. 
    ... for the internet and on your computer! Right now, content is found by locat...
                                           ^^^^^^^^^
  • Do not use a colon (:) before a series that is introduced by a preposition (‘as’). Remove the colon or add a noun or a noun phrase after the preposition. 
    ...now, content is found by location, such as: https://en.wikipedia.org/wiki/Aa...
                                           ^^^
  • Consider using “many”. 
    ..., but you can structure a Merkle DAG in many different ways. For example, Gi...
                                           ^^^^^^^^^^^^^^
  • This phrase is redundant. Consider using “inside”. 
    ...DAG that has many versions of your repo inside of it. To build a Merkle DAG ...
                                           ^^^^^^^^^
  • It seems likely that a singular genitive (’s) apostrophe is missing. 
    ...ew window). Merkle DAGs are a bit of a "turtles all the way down"  (opens ne...
                                           ^^^^^^^
  • Possible typo detected. 
    ... find content, you ask these peers. The libp2p project  (opens new window) i...
                                           ^^^^^^
  • Possible typo detected. 
    ...o each other. (Note that, as with IPLD, libp2p can also be used as a tool fo...
                                           ^^^^^^
  • Possible typo detected. 
    ...s (routing). So, to get to content, use libp2p to query the DHT twice. You'v...
                                           ^^^^^^
  • ‘under discussion’ might be wordy. Consider a shorter alternative. 
    ...are other content replication protocols under discussion  (opens new window)...
                                           ^^^^^^^^^^^^^^^^
  • ‘under discussion’ might be wordy. Consider a shorter alternative. 
    ...ns new window). There's also a proposal under discussion to extend the Bitsw...
                                           ^^^^^^^^^^^^^^^^
  • Possible typo detected. 
    ...e Content Identifiers are not hashes. # Libp2p What makes libp2p especially ...
                                           ^^^^^^
  • Possible typo detected. 
    ...ers are not hashes. # Libp2p What makes libp2p especially useful for peer-to...
                                           ^^^^^^
  • Reduce redundancy by only using “bit”. 
    ...to talk to each other about, you send a little bit of each thing, and the ot...
                                           ^^^^^^^^^^
  • Possible typo detected. 
    ... content using a DHT that's provided by libp2p, open a connection to any pro...
                                           ^^^^^^

docs/concepts/nodes.md:

  • Possible typo detected. 
    ...s of nodes: IPFS nodes, data nodes, and libp2p nodes for applications. IPFS ...
                                           ^^^^^^
  • Consider using “several”. 
    ... data with other IPFS nodes. They go by several different names, but we refe...
                                           ^^^^^^^^^^^^^^^^^
  • Only proper nouns start with an uppercase character (there are exceptions for headlines). 
    ...peer to other peers. See Observe peers, Exchange files between nodes, and Pe...
                                           ^^^^^^^^
  • This phrase is redundant. Consider writing “point” or “time”. 
    ...running on an IPFS node at a particular point in time. The peer ID is the sa...
                                           ^^^^^^^^^^^^^
  • Only proper nouns start with an uppercase character (there are exceptions for headlines). 
    ...d. See Go-IPFS and JS-IPFS. Data nodes, Use data nodes when talking about ac...
                                           ^^^
  • Possible typo detected. 
    ...IPLD) model docs, which is in progress. libp2p peer Use libp2p peer when tal...
                                           ^^^^^^
  • Only proper nouns start with an uppercase character (there are exceptions for headlines). 
    ...docs, which is in progress. libp2p peer Use libp2p peer when talking about l...
                                           ^^^
  • Possible typo detected. 
    ..., which is in progress. libp2p peer Use libp2p peer when talking about libp2...
                                           ^^^^^^
  • Possible typo detected. 
    ...peer Use libp2p peer when talking about libp2p nodes on which you can build ...
                                           ^^^^^^
  • Possible typo detected. 
    ...They're usually referred to as peers in libp2p, because it provides solution...
                                           ^^^^^^
  • If the ‘because’ clause is essential to the meaning, do not use a comma before the clause. 
    ...e usually referred to as peers in libp2p, because it provides solutions for ...
                                           ^^^^^^^^^
  • Possible typo detected. 
    .... JS-ipfs nodes remain connected to the libp2p swarm ports of all preload no...
                                           ^^^^^^
  • Possible typo detected. 
    ... bootstrap nodes, so they will maintain libp2p swarm connections to them at ...
                                           ^^^^^^
  • Possible missing comma found. 
    ...Can be either Go-IPFS or JS-IPFS nodes; however there are standalone impleme...
                                           ^^^^^^^
  • The preposition ‘with’ is not usually used with the verb ‘talk’. Consider using ‘speak’ instead, or replacing the preposition. 
    ...e with WebSockets/webRTC transports can talk with a Go-IPFS node that only c...
                                           ^^^^^^^^^
  • Possible missing comma found. 
    ...rable in go-ipfs; uses a preset list of relays See p2p-circuit relay  (opens...
                                           ^^^^^^
  • Only proper nouns start with an uppercase character (there are exceptions for headlines). 
    ...c DHT if it were to restart. More about Bootstrapping # Delegate routing nod...
                                           ^^^^^^^^^^^^^
  • Possible typo detected. 
    ... bootstrap nodes, so they will maintain libp2p swarm connections to them at ...
                                           ^^^^^^

docs/how-to/command-line-quick-start.md:

  • Possible missing comma found. 
    ...reference implementation written in Go. TIP Don’t want to use the command li...
                                           ^^^
  • The word ‘install’ is not a noun. 
    ...e not yet installed Go-IPFS, follow the install instructions. # Initialize t...
                                           ^^^^^^^
  • The phrase ‘a lot of’ might be wordy. Consider using “many”, “numerous” or “countless”. 
    ...oing so will prevent IPFS from creating a lot of data center-internal traffi...
                                           ^^^^^^^^
  • This abbreviation for “identification” is spelled all-uppercase. 
    ...nd and connect to you. You can run ipfs id at any time to get it again if yo...
                                           ^^
  • This word has been used in one of the immediately preceding sentences. Using a synonym could make your text more interesting to read, unless the repetition is intentional. 
    ...s id at any time to get it again if you need it. Now, try running the comman...
                                           ^^^^
  • Only proper nouns start with an uppercase character (there are exceptions for headlines). 
    ... your computer. The gateway queried the Distributed hash table (DHT), found ...
                                           ^^^^^^^^^^^
  • You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing. 
    ...ges. # Check that FUSE is installed You need to install and set up FUSE in o...
                                           ^^^^^^^
  • Consider a shorter alternative to avoid wordiness. 
    ...led You need to install and set up FUSE in order to mount the file system. F...
                                           ^^^^^^^^^^^

docs/how-to/configure-node.md:

  • Possible missing comma found. 
    ...rofile apply command. When a profile is applied a backup of the configuratio...
                                           ^^^^^^^
  • As an alternative to the over-used intensifier ‘very’, consider replacing this phrase. 
    ... should use this datastore if: You need a very simple and very reliable data...
                                           ^^^^^^^^^^^^^
  • Possible missing comma found. 
    ...ou need a very simple and very reliable datastore you and trust your filesys...
                                           ^^^^^^^^^
  • Possible missing comma found. 
    ...ck as a separate file in the underlying filesystem so it's unlikely to lose ...
                                           ^^^^^^^^^^
  • Do you wish to insert an arrow? 
    ...d to run garbage collection on a small (<= 10GiB) datastore. The default dat...
                                           ^^
  • Insert a space between the numerical value and the unit symbol. 
    ...o run garbage collection on a small (<= 10GiB) datastore. The default datast...
                                           ^^^^^
  • This word has been used in one of the immediately preceding sentences. Using a synonym could make your text more interesting to read, unless the repetition is intentional. 
    ...ult configuration, badger can use up to several gigabytes of memory. This pr...
                                           ^^^^^^^
  • This word has been used in one of the immediately preceding sentences. Using a synonym could make your text more interesting to read, unless the repetition is intentional. 
    ...ace when your datastore is smaller than several gigabytes. If you run IPFS w...
                                           ^^^^^^^
  • Try using a more formal synonym here to elevate your writing. 
    ...ed block-level garbage collection), you plan on storing very little data in ...
                                           ^^^^^^^^^^^^^^^
  • This word has been used in one of the immediately preceding sentences. Using a synonym could make your text more interesting to read, unless the repetition is intentional. 
    ...using flatfs. This datastore uses up to several gigabytes of memory. This pr...
                                           ^^^^^^^
  • If a new sentence starts here, add a space and start with an uppercase letter. 
    ...es to be used by this node. # Addresses.API Multiaddr or array of multiaddrs...
                                           ^^^
  • Do you wish to insert an arrow? 
    ...mple: Default: null Type: object[string -> array[string]] (header names -> a...
                                           ^^
  • Do you wish to insert an arrow? 
    ...[string -> array[string]] (header names -> array of header values) # AutoNAT...
                                           ^^
  • The verb after “to” should be in the base form. 
    ...fault), the AutoNAT service defaults to enabled. Otherwise, this field can t...
                                           ^^^^^^^
  • Only proper nouns start with an uppercase character (there are exceptions for headlines). 
    ... for the above limits. Default: 1m0s (1 Minute) Type: duration (when set to ...
                                           ^^^^^^
  • Consider a shorter alternative to avoid wordiness. 
    ...ltiaddrs of trusted nodes to connect to in order to initiate a connection to...
                                           ^^^^^^^^^^^
  • Possible missing comma found. 
    ...the on-disk storage system. # Datastore.StorageMax A soft upper limit for th...
                                           ^^^^^^^^^^
  • Insert a space between the numerical value and the unit symbol. 
    ... if --enable-gc flag is set). Default: "10GB" Type: string (size) # Datastor...
                                           ^^^^
  • Possible missing comma found. 
    ...use increased CPU utilization. Default: false Type: bool # Datastore.BloomFi...
                                           ^^^^^
  • Possible missing comma found. 
    .... Default: false Type: bool # Datastore.BloomFilterSize A number representin...
                                           ^^^^^^^^^^^^^^^
  • Possible missing comma found. 
    ... in bits. Remember to convert the value m from bits, into bytes for use as B...
                                           ^
  • The abbreviation “e.g.” (= for example) requires two periods. 
    ...astores to provide extra functionality (eg metrics, logging, or caching). Th...
                                           ^^
  • Consider shortening this phrase to just “whether”. It is correct though if you mean ‘regardless of whether’. 
    ...covery.MDNS.Enabled A boolean value for whether or not mdns should be active...
                                           ^^^^^^^^^^^^^^
  • Possible missing comma found. 
    ... fetch files from the network. Default: false Type: bool # Gateway.NoDNSLink...
                                           ^^^^^
  • Possible missing comma found. 
    ...rk. Default: false Type: bool # Gateway.NoDNSLink A boolean to configure whe...
                                           ^^^^^^^^^
  • Possible missing article found. 
    ...ld be performed. If DNSLink is present, content path stored in the DNS TXT r...
                                           ^^^^^^^
  • Possible missing article found. 
    ...in the DNS TXT record becomes the / and respective payload is returned to th...
                                           ^^^^^^^^^^
  • Do you wish to insert an arrow? 
    ...responses. Default: Type: object[string -> array[string]] # Gateway.RootRedi...
                                           ^^
  • Possible missing comma found. 
    ...ject[string -> array[string]] # Gateway.RootRedirect A url to redirect reque...
                                           ^^^^^^^^^^^^
  • Possible missing comma found. 
    ...efault: "" Type: string (url) # Gateway.Writable A boolean to configure whet...
                                           ^^^^^^^^
  • Possible missing comma found. 
    ...e gateway is writeable or not. Default: false Type: bool # Gateway.PathPrefi...
                                           ^^^^^
  • Did you mean “mount a blog”? 
    ...tend http proxy like nginx. Example: We mount blog.ipfs.io (a dnslink page) ...
                                           ^^^^^^^^^^
  • Possible missing comma found. 
    ...se Type: bool # Gateway.PublicGateways: NoDNSLink A boolean to configure whe...
                                           ^^^^^^^^^
  • Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’. 
    ...se proxy that provides TLS, make it add a X-Forwarded-Proto: https HTTP head...
                                           ^
  • Only proper nouns start with an uppercase character (there are exceptions for headlines). 
    ...of the box unless set to true manually) Hardened, site-specific DNSLink gate...
                                           ^^^^^^^^
  • Possible missing comma found. 
    ...oDNSLink": true,  # Identity # Identity.PeerID The unique PKI identity label...
                                           ^^^^^^
  • The demonstrative ‘this’ may not agree with the plural noun ‘configs’. Did you mean “these”? 
    ...eerID The unique PKI identity label for this configs peer. Set on init and n...
                                           ^^^^
  • Possible missing comma found. 
    ...time. Type: string (peer ID) # Identity.PrivKey The base64 encoded protobuf ...
                                           ^^^^^^^
  • It seems likely that a singular genitive (’s) apostrophe is missing. 
    ...rotobuf describing (and containing) the nodes private key. Type: string (bas...
                                           ^^^^^
  • Possible missing comma found. 
    ...: string (base64 encoded) # Ipns # Ipns.RepublishPeriod A time duration spec...
                                           ^^^^^^^^^^^^^^^
  • Possible missing comma found. 
    ...an empty string for the default. # Ipns.RecordLifetime A time duration speci...
                                           ^^^^^^^^^^^^^^
  • If this is a compound adjective that modifies the following noun, use a hyphen. 
    ...for managing that service's interest in longer term data storage. The expose...
                                           ^^^^^^^^^^^
  • Possible missing comma found. 
    ...elevant to utilizing the remote pinning service Example: # Pinning.RemoteSer...
                                           ^^^^^^^
  • ‘cafes’ is an imported foreign expression, which originally has a diacritic. Consider using “cafés”. 
    ...th a set of pinning services or textile cafes/hubs. A set of friends may pee...
                                           ^^^^^
  • Did you mean “very”? 
    ...tected by both nodes and will likely be vary stable. When asymmetric, only o...
                                           ^^^^
  • Possible missing comma found. 
    ...eering to not overload peers. # Peering.Peers The set of peers with which to...
                                           ^^^^^
  • Only proper nouns start with an uppercase character (there are exceptions for headlines). 
    ...e: array[peering] # Reprovider.Strategy Tells reprovider what should be anno...
                                           ^^^^^
  • Style-wise, it’s not ideal to insert an adverb (‘explicitly’) in the middle of an infinitive construction (‘to connect’). Try moving the adverb to avoid split infinitives. 
    ...node will use no routing system. You'll have to explicitly connect to peers ...
                                           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  • Only proper nouns start with an uppercase character (there are exceptions for headlines). 
    ...source intensive than server mode. When Routing.Type is set to dht, your nod...
                                           ^^^^^^^
  • Only proper nouns start with an uppercase character (there are exceptions for headlines). 
    ...pecific DHT mode, client or server, set Routing.Type to dhtclient or dhtserv...
                                           ^^^^^^^
  • Possible missing comma found. 
    ...erver, set Routing.Type to dhtclient or dhtserver respectively. Please do no...
                                           ^^^^^^^^^
  • Possible missing comma found. 
    ...ions for configuring the swarm. # Swarm.AddrFilters An array of addresses (m...
                                           ^^^^^^^^^^^
  • Possible missing comma found. 
    ...DisableBandwidthMetrics A boolean value that when set to true, will cause ip...
                                           ^^^^
  • Possible missing comma found. 
    ...s a reduction in memory usage. Default: false Type: bool # Swarm.DisableNatP...
                                           ^^^^^
  • Possible missing comma found. 
    ...ible from the public internet. Default: false Type: bool # Swarm.DisableRela...
                                           ^^^^^
  • Possible missing comma found. 
    ...ions from nodes behind relays. Default: false Type: bool # Swarm.EnableRelay...
                                           ^^^^^
  • The preposition ‘to’ seems more likely in this position. 
    ...lay "hop". A relay "hop" relays traffic for other peers. WARNING: Do not ena...
                                           ^^^
  • Possible missing comma found. 
    ...th. There is no rate-limiting. Default: false Type: bool # Swarm.EnableAutoR...
                                           ^^^^^
  • Only proper nouns start with an uppercase character (there are exceptions for headlines). 
    ...If Swarm.EnableAutoRelay is enabled and Swarm.EnableRelayHop is disabled, yo...
                                           ^^^^^
  • Possible missing comma found. 
    ...same time. # Swarm.EnableAutoNATService REMOVED Please use [AutoNAT.ServiceM...
                                           ^^^^^^^
  • Consider adding a comma here. 
    ...me. # Swarm.EnableAutoNATService REMOVED Please use [AutoNAT.ServiceMode][]....
                                           ^^^^^^^
  • Possible typo detected. 
    ...rm.Transports Configuration section for libp2p transports. An empty configur...
                                           ^^^^^^
  • Possible typo detected. 
    ...ports.Network Configuration section for libp2p network transports. Transport...
                                           ^^^^^^
  • Only proper nouns start with an uppercase character (there are exceptions for headlines). 
    ...s for these transports must be added to Addresses.Swarm. Supported transport...
                                           ^^^^^^^^^
  • Possible typo detected. 
    ...port encryption and/or multiplexing, so libp2p will layer a security & multi...
                                           ^^^^^^
  • Possible typo detected. 
    ...fault) # Swarm.Transports.Network.Relay Libp2p Relay  (opens new window) pro...
                                           ^^^^^^
  • Possible typo detected. 
    ...connections by hopping between multiple libp2p nodes. This transport is prim...
                                           ^^^^^^
  • Possible typo detected. 
    ...orts.Security Configuration section for libp2p security transports. Transpor...
                                           ^^^^^^
  • Only proper nouns start with an uppercase character (there are exceptions for headlines). 
    ... SECIO (Disabled: i.e. priority false), Noise (priority 300). No default pri...
                                           ^^^^^
  • Possible typo detected. 
    ...w) was the most widely supported IPFS & libp2p security transport. However, ...
                                           ^^^^^^
  • Possible missing comma found. 
    ... protocols like TLS and Noise. Default: false Type: priority # Swarm.Transpo...
                                           ^^^^^
  • Possible typo detected. 
    ...lace TLS as the cross-platform, default libp2p protocol due to ease of imple...
                                           ^^^^^^
  • Possible typo detected. 
    ....Multiplexers Configuration section for libp2p multiplexer transports. Trans...
                                           ^^^^^^
  • Possible typo detected. 
    ... between go-ipfs and all other IPFS and libp2p implementations. Unlike Yamux...
                                           ^^^^^^
  • The verb form ‘specifies’ does not seem to match the subject ‘values’. 
    ... Unlike Yamux: The mounts config values specifies the default mount points f...
                                           ^^^^^^^^^

docs/install/ipfs-desktop.md:

  • The following link returned HTTP status code 302 (Found):
    https://community.chocolatey.org/packages/ipfs-desktop
  • The following link returned HTTP status code 307 (Temporary Redirect):
    https://aur.archlinux.org/packages/ipfs-desktop/
  • This phrase is duplicated. You should probably use “IPFS Desktop” only once. 
    # IPFS Desktop IPFS Desktop bundles an IPFS node, file manager, pee...
  ^^^^^^^^^^^^^^^^^^^^^^^^^
  • Only proper nouns start with an uppercase character (there are exceptions for headlines). 
    ...nubar/taskbar      # Feature highlights Start your node at system startup (M...
                                           ^^^^^
  • The word ‘install’ is not a noun. 
    ...n the computer. Click Next:  Select the install location for the application...
                                           ^^^^^^^
  • A word may be missing after ‘the’. 
    ...window). Move into where you downloaded the .AppImage file, and make it exec...
                                           ^^^^^
  • A word may be missing after ‘the’. 
    ...age file, and make it executable:  Open the .AppImage by calling ./ipfs-desk...
                                           ^^^^^
  • A word may be missing after ‘the’. 
    ...from the command-line: You can also run the .AppImage file by double-clickin...
                                           ^^^^^

@johnnymatthews johnnymatthews merged commit bb41e39 into main Feb 25, 2022
@johnnymatthews johnnymatthews deleted the nodes branch February 25, 2022 02:56
@Annamarie2019 Annamarie2019 mentioned this pull request Mar 3, 2022
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@yusefnapora yusefnapora yusefnapora approved these changes

@johnnymatthews johnnymatthews johnnymatthews approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@Annamarie2019 @filecorgi @yusefnapora @johnnymatthews